home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / qne30.zip / QNE30.DOC next >
Text File  |  1988-09-08  |  19KB  |  441 lines
  1.  
  2.                             QUICK NEWS EDITOR v3.0
  3.                  
  4.  
  5.                                 Scott M. Pazur
  6.                                   PO Box 582
  7.                             Englishtown, NJ  07726
  8.                  
  9.  
  10. Quick News Editor (QNExx.EXE) is just that, a simple and fast way to update
  11. your PC-Board NEWS and NEWSG, or any other BBS System intro files, to bring 
  12. the latest news to your users.  QNE's editor functions similiar to that
  13. provided in PC-Board software, but now adds major enhancements to make your
  14. news file creation easier and faster than ever.
  15.  
  16.  
  17. I no longer run a public BBS system, but can be reached on either of the
  18. following PC-Board systems:
  19.  
  20.  The Right Choice BBS   Spring Lake Hts, NJ   201-974-8317 1200/2400
  21.  The Jersey Shore BBS   Sayreville, NJ        201-613-7350 HST 
  22.  
  23.  
  24. A CGA (at least) graphic card is REQUIRED for QNE 3.0!
  25.  
  26.  
  27.  
  28. Version 3.0 Release Notes - September 8, 1988
  29.  
  30. As the release notes for v2.1 promised, this is a MAJOR revision from that
  31. version.  The changes/additions are outlined here, with more detail provided
  32. later in this document.
  33.  
  34.   - Completely rewritten with a new user interface
  35.   - No longer free-ware.  This version IS a fully-functional, un-crippled,
  36.     unrestricted release, but please consider registering your copy.  I am
  37.     no longer a Sysop, so your registrations will keep me writing these
  38.     Sysop utilities.  A registration form is provided at the end of this
  39.     file.
  40.   - Maximum number of lines in output upped to 99
  41.   - Optional configuration file replaces the dozens of possible command
  42.     line switches of previous releases
  43.   - On-line help screen available
  44.   - DOS shell hotkey available
  45.   - On-the-fly output color configuration screen available
  46.   - Text justification added to editor
  47.   - Item-Deletion module added (previously released separately as QNE-IDxx)
  48.   - Foreground AND background colors now configurable
  49.  
  50. More detail on these revisions can be found later in this documentation.
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57. Starting QNE:
  58.  
  59.      QNE30 [/D:filename]
  60.       
  61.      The /D option loads the Item Deletion module rather than the editor.
  62.      Follow the /D with a colon (:) and the QNE produced filename to
  63.      process.  This Item Deletion module lets you easily remove past news
  64.      items without having to interpret the ansi codes in your favorite 
  65.      text editor.
  66.  
  67. QNE.CFG - The Configurataion File and optional environment variable
  68.  
  69.      QNE v3.0 now uses an optional configuration file to set up its
  70.      variable options.  If used, this configuration file MUST be named
  71.      QNE.CFG.  QNE 3.0 will first scan your environment variables for 
  72.      one named QNE to determine the location of this QNE.CFG file.
  73.      (i.e. SET QNE=C:\PCB\MISC would force QNE30 to look in the 
  74.      directory named "c:\pcb\misc" for the QNE.CFG file).  If this variable
  75.      is not set, then QNE30 will look in the current directory for the 
  76.      QNE.CFG file.  If it is still not found, the default values outlined
  77.      below will be used.
  78.       
  79.      The QNE.CFG file is st up as follows:
  80.       
  81.      LINE 1
  82.        Line 1 tells QNE about the non-graphic version of the output 
  83.        (commonly known as NEWS).  There are 5 possible values that can be
  84.        present on this line:
  85.      
  86.        [0/1][,NewsFileName,][0/1][,HeaderFileName][,NOUPPER]
  87.      
  88.        The first item tells QNE whether or not to create the non-graphic 
  89.        file.  If this first entry is "0", then there is no need for 
  90.        anything else on this line.  If you want the non-graphic version 
  91.        (usually yes), you must then follow the "1" with a comma, then the 
  92.        name of the file you wish to create/update, then another comma, 
  93.        then a "0" or "1" to indicate the desire for a header file.  If you
  94.        do want the header file, this "1" must be followed by another 
  95.        comma, then the name of the header file to use with the non-graphic
  96.        version.  If you do not want the upper-ascii "box" characters in 
  97.        this version of the output, also add ",NOUPPER" to the end of this
  98.        line.
  99.  
  100.      LINE 2
  101.        Line 2 tells QNE about the graphic version of the output (commonly
  102.        known as NEWSG).  This line is set up exactly the same as line 1 
  103.        above, with the exception of the ",NOUPPER" option, which is not 
  104.        supported on this line.
  105.      
  106.  
  107.  
  108.  
  109.      LINES 3 through 6
  110.        These lines are for color selections, and must all be present. 
  111.        Each line has two entries separated by a comma.  They indicate the
  112.        foreground and background colors for the following items:
  113.          Line 3:  Line (news item seperator) Color
  114.          Line 4:  Date Color
  115.          Line 5:  Title Color
  116.          Line 6:  News Text Color
  117.        The values that can be included here are:
  118.          0 - Black
  119.          1 - Blue
  120.          2 - Green
  121.          3 - Cyan
  122.          4 - Red
  123.          5 - Magnta
  124.          6 - Yellow
  125.          7 - White
  126.  
  127.      Sample QNE.CFG file (my explanations are usually not understandable)
  128.    
  129.       1,C:\PCB\GEN\NEWS,1,C:\PCB\MISC\HEADER
  130.       1,C:\PCB\GEN\NEWSG,1,C:\PCB\MISC\HEADERG
  131.       6,1
  132.       3,1
  133.       7,1
  134.       6,0
  135.    
  136.       Will update a non-graphic version, named NEWS in "C:\PCB\GEN".  The
  137.       header file HEADER in "C:\PCB\MISC" will be used at the top of the 
  138.       NEWS file.  The "box" characters WILL be used in this output.
  139.       WILL update a graphic version, named NEWSG in "C:\PCB\GEN".  
  140.       QNE will also use the header file HEADERG in "C:\PCB\MISC" in the 
  141.       output.
  142.       The colors will be:
  143.        Line:  Yellow on Blue
  144.        Date:  Cyan on Blue
  145.        Title: White on Blue
  146.        Text:  Yellow on Black
  147.  
  148.  
  149. Default Values used if no QNE.CFG file found
  150.  
  151.      QNE v3.0 will use the following default values if no configuration
  152.      file is found:
  153.        - Line (news item separator) Color:  Blue on Black
  154.        - Date Color:  Yellow on Black
  155.        - Title Color:  Green on Black
  156.        - Text Color:  Cyan on Black
  157.        - Non-graphic news file:  YES, named NEWS in current directory
  158.        - Graphic news file:  YES, named NEWSG in current directory
  159.        - Header files:  NO
  160.        - Upper Ascii characters in non-graphic file:  YES
  161.  
  162.  
  163.  
  164.  
  165.  
  166. QNE's Edit Mode:
  167.  
  168.   Upon starting QNE, you will be prompted for an optional title for this
  169.   session's news text.  Hitting [Enter] with no text at this time will 
  170.   leave the title out of the QNE output.
  171.  
  172.   After the title prompt, you will be put into Edit Mode.  Enter your text
  173.   as you would enter a message on any PC-Board system.  Text will wrap as
  174.   you type.
  175.  
  176.   Hot-keys available in Edit Mode are:
  177.  
  178.       Alt-Q   loads a DOS command shell.  "EXIT" will return to QNE.
  179.       Home    displays a help screen of the QNE options
  180.       F10     loads the color configuration module
  181.  
  182.   By entering a blank line, you leave Edit Mode and enter Command Mode.
  183.  
  184.  
  185.  
  186.  
  187. QNE's Command Mode:
  188.   
  189.   After leaving Edit Mode, you will be presented a selection bar of
  190.   possible Command Mode options:
  191.    
  192.   Up/Down/PgUp/PgDn/End/Home - Scrolls through text
  193.  
  194.   A - Abort editing session - you will be asked to verify your selection
  195.  
  196.   C - Continue editing session at last line
  197.  
  198.   D - Delete line of text - line selected will be displayed on line 25
  199.       and you will be asked for verification before deletion
  200.  
  201.   E - Edit line of text.  Enhanced to full line edit.  No more 
  202.       "oldtext;newtext" style.
  203.  
  204.   I - Insert line(s) of text - you will be put back into Edit Mode at
  205.       the line number you desire and text will be inserted at this point.
  206.  
  207.   J - Justify text - see notes below
  208.  
  209.   M - Merge text file into editing session - see notes below
  210.  
  211.   S - Save session and exit - again, you will be asked for verification
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218. Justification Notes:
  219.  
  220.   This was a tricky one, and the results may not be exactly what you
  221.   expect.  I've done my best to emulate as close as possible true text
  222.   justification with the following two restrictions:
  223.  
  224.     - Any line of text beginning with a space will not be affected.
  225.       This is to allow "bullet items" to retain their emphasis.
  226.  
  227.     - Any line less than 60 characters in length will not be affected.
  228.       This is to prevent too many extra spaces in the text.
  229.        
  230.  
  231.  
  232. Merge Notes:
  233.  
  234.    - Just as you are limited to 74 characters per line in the editor, the
  235.      merge file is also limited to 74 characters per line.  Any lines 
  236.      longer than 74 characters (including ansi codes) will be truncated.
  237.  
  238.    - Will import a text file into the news text.  Eventhough ANSI codes 
  239.      for color etc. will be read in correctly, due to the way QNE output
  240.      is formatted, it will probably not end up as you want it to.
  241.      Therefore, it is recommended that any merge file be straight ASCII 
  242.      text.
  243.  
  244.  
  245.  
  246. Notes on output:
  247.  
  248.      The "NOUPPER" flag restricts the use of the upper ascii, or "box"
  249.      characters, from the non-graphic NEWS file.  This has the following
  250.      effect on the output:
  251.  
  252.         Without "NOUPPER"
  253.  
  254.                 ╔══════════════════════════╗
  255.             ════╣ September 8:  Title line ╠═══...
  256.                 ╚══════════════════════════╝
  257.  
  258.         With "NOUPPER"
  259.  
  260.        
  261.             ====[ September 8:  Title line ]===...
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. Revision History
  269. ============================================================================
  270. Version 3.0 - September 8, 1988
  271.  
  272. As the release notes for v2.1 promised, this is a MAJOR revision from that
  273. version.  The changes/additions are outlined here, with more detail provided
  274. later in this document.
  275.  
  276.   - Completely rewritten with a new user interface
  277.   - No longer free-ware.  This version IS a fully-functional, un-crippled,
  278.     unrestricted release, but please consider registering your copy.  I am
  279.     no longer a Sysop, so your registrations will keep me writing these
  280.     Sysop utilities.  A registration form is provided at the end of this
  281.     file.
  282.   - Maximum number of lines in output upped to 99
  283.   - Optional configuration file replaces the dozens of possible command
  284.     line switches of previous releases
  285.   - On-line help screen available
  286.   - DOS shell hotkey available
  287.   - On-the-fly output color configuration screen available
  288.   - Text justification added to editor
  289.   - Item-Deletion module added (previously released separately as QNE-IDxx)
  290.   - Foreground AND background colors now configurable
  291.  
  292. ============================================================================
  293. Version 2.1 - November 16, 1987
  294.  
  295. Nothing major (YET!).  I had intended on this being a major update, but free
  296. time suddenly became a thing of the past again.  Look for v3.0 to drasticly
  297. change QNE.  As for this version:
  298.  Fixed:  1.  The problem with backspacing going past the line number.
  299.          2.  The problem with line wrap not working when [I]nserting
  300.  
  301.  Changed:  1. Output!  New title line looks like:
  302.               ╔═════════════════════════════════════════╗
  303.           ════╣ November 11:  Test #1 of Beta version 3 ╠════════...
  304.               ╚═════════════════════════════════════════╝
  305.               I didn't want any lawsuits from the PCBNEWS author who says
  306.               that "the look and feel of PCBNEWS is copyright...", but
  307.               whose output is exactly the same as QNE v2.0 and below (grin)
  308.  
  309.  Added:  1.  New options (like it really needs more!) to allow 
  310.              customization of the output colors.  See the section titled
  311.              "Starting QNE" for more info.
  312.  
  313. ============================================================================
  314. Version 2.0 - August 26, 1987
  315.  
  316. Yes, line wrap is finally here!  This is the biggest addition to this 
  317. version.  The other biggie is the optional title on the news item being 
  318. edited.  You will always be prompted for a title, and if you do not want
  319. one, simply hit enter to skip the title.  Some little additions are removal
  320. of the /I option (if you haven't upgraded to 1.7 or 1.8 yet, you'll have to
  321. start all over to get the /H option to work properly).  I've added a /? 
  322. option for help with the command line options (for those of us that hate
  323. docs).  Finally, the news text is indented for a more symmetric-type 
  324. display, and the local misalignment in versions 1.7 and 1.8 is fixed.
  325.  
  326.  
  327.  
  328.  
  329. ============================================================================
  330. Version 1.8 - July 3, 1987
  331.  
  332. Added option (/M:filename) for merge file facility.  This will take a text
  333. file and merge it into your news text.  See notes below.
  334. Also added a check for a graphics version of the header file.
  335.  
  336. ============================================================================
  337. Version 1.7 - June 14, 1987
  338.  
  339. Added option (/H:filename) for header file to be included in NEWS/NEWSG.  
  340. Also, an option (/I) has been added to initialize old output of QNE for the
  341. use of the header files.  This initialization MUST be done once on output
  342. produced by QNE versions 1.6 and below in order for the header option to
  343. work correctly.  See the info below on /I for more information.
  344. ============================================================================
  345. Version 1.6 - June 2, 1987
  346.  
  347. Minor fix/addition release to allow upper ASCII characters to be used when
  348. editing a NEWS file.  Had to recompile with QuickBasic instead of Turbo Basic
  349. to accomplish this.  Another strike against Turbo Basic.
  350. ============================================================================
  351. Version 1.5 - May 29, 1987
  352.  
  353. Thanx to Gary Thurlow for pointing out a bug in version 1.4 that didn't 
  354. allow the use of path\filename.  It worked fine when editing a file in the
  355. current directory, but blew up when a path longer than 8 characters was 
  356. used.  I'm happy to report that all is now well, enjoy...
  357. ============================================================================
  358. Version 1.4 - May 27, 1987
  359.  
  360. By request, added an option (/G) to eliminate ASCII graphics characters from
  361. the non-graphic output file if so desired.
  362. ============================================================================
  363. Version 1.3 - April 30, 1987
  364.  
  365. Initial release, fully functional, open for suggestions for future releases!
  366. ============================================================================
  367.  
  368. |--------------------------------------------------------------------------|
  369. |                 Quick News Editor v3.0 Registration Form                 |
  370. |                                                                          |
  371. |                     Suggested Contribution is $15.00                     |
  372. |                                                                          |
  373. |                              Please Send To                              |
  374. |                              --------------                              |
  375. |                              Scott M. Pazur                              |
  376. |                                PO Box 582                                |
  377. |                           Englishtown NJ 07726                           |
  378. |                                                                          |
  379. |--------------------------------------------------------------------------|
  380. |                                                                          |
  381. |                                                                          |
  382. | Name: _____________________________________________  Date: _____________ |
  383. |                                                                          |
  384. | Mailing Address: _______________________________________________________ |
  385. |                                                                          |
  386. |            City: _______________________________________________________ |
  387. |                                                                          |
  388. |      State, Zip: _______________________________________________________ |
  389. |                                                                          |
  390. |                                                                          |
  391. | Voice Phone Number (days): _____________________________________________ |
  392. |                                                                          |
  393. | Voice Phone Number (eves): _____________________________________________ |
  394. |                                                                          |
  395. |                                                                          |
  396. | BBS System Name: _______________________________________________________ |
  397. |                                                                          |
  398. | BBS Software (and version): ____________________________________________ |
  399. |                                                                          |
  400. | BBS Phone Number(s): ___________________________________________________ |
  401. |                      ___________________________________________________ |
  402. |                                                                          |
  403. | Baud Rates (if 9600+, modem used): _____________________________________ |
  404. |                                                                          |
  405. | Suggestions for future releases:                                         |
  406. | ________________________________________________________________________ |
  407. | ________________________________________________________________________ |
  408. | ________________________________________________________________________ |
  409. | ________________________________________________________________________ |
  410. | ________________________________________________________________________ |
  411. | ________________________________________________________________________ |
  412. | ________________________________________________________________________ |
  413. |                                                                          |
  414. |                                                                          |
  415. | Thank You for your support.  For questions, I can be reached on either   |
  416. | of the following PC-Board systems:                                       |
  417. |                                                                          |
  418. |                                                                          |
  419. |  The Right Choice BBS   Spring Lake Hts NJ   201-974-8317 Public Node    |
  420. |                                                           1200/2400      |
  421. |                                                                          |
  422. |  The Jersey Shore BBS   Sayreville NJ        201-613-7350 9600 w/HST     |
  423. |                                                                          |
  424. ----------------------------------------------------------------------------
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.